Skip to content

Added a comprehensive CONTRIBUTING.md to improve contributor onboarding#1258

Open
indresh404 wants to merge 3 commits into
Priyanshu-byte-coder:mainfrom
indresh404:documentation/contributing-guide
Open

Added a comprehensive CONTRIBUTING.md to improve contributor onboarding#1258
indresh404 wants to merge 3 commits into
Priyanshu-byte-coder:mainfrom
indresh404:documentation/contributing-guide

Conversation

@indresh404
Copy link
Copy Markdown
Contributor

@indresh404 indresh404 commented May 27, 2026

Summary

Added a comprehensive CONTRIBUTING.md to improve contributor onboarding and standardize the contribution workflow for the project.

This PR also updates setup documentation to consistently use pnpm across all developer guides.

Closes #1029

Type of Change

  • Bug fix
  • New feature
  • Documentation update
  • Refactor / code cleanup

Changes Made

  • Added a structured CONTRIBUTING.md
  • Added Quick Start section (<10 steps)
  • Documented:
    • Prerequisites
    • Local setup
    • Environment variables
    • Code style & linting
    • Branch naming conventions
    • Conventional commits
    • PR checklist
    • GSSoC issue labels
    • Self-hosting references
  • Added Code of Conduct reference
  • Updated README.md setup commands to use pnpm
  • Updated DEVELOPMENT.md to align with pnpm

How to Test

  1. Open CONTRIBUTING.md
  2. Verify all required sections are present
  3. Follow Quick Start instructions
  4. Confirm all commands use pnpm
  5. Verify references in:
    • README.md
    • DEVELOPMENT.md

Screenshots (if UI change)

N/A — Documentation-only changes

Checklist

  • Linked issue in summary
  • pnpm lint passes locally
  • No TypeScript errors (pnpm type-check)
  • Self-reviewed the diff
  • Added/updated tests if applicable

@vercel
Copy link
Copy Markdown

vercel Bot commented May 27, 2026

@indresh404 is attempting to deploy a commit to the PRIYANSHU DOSHI's projects Team on Vercel.

A member of the Team first needs to authorize it.

@github-actions github-actions Bot added gssoc26 GSSoC 2026 contribution type:docs GSSoC type bonus: documentation (+5 pts) labels May 27, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 27, 2026

GSSoC Label Checklist 🏷️

@Priyanshu-byte-coder — please apply the appropriate labels before merging:

Difficulty (pick one):

  • level:beginner — 20 pts
  • level:intermediate — 35 pts
  • level:advanced — 55 pts
  • level:critical — 80 pts

Quality (optional):

  • quality:clean — ×1.2 multiplier
  • quality:exceptional — ×1.5 multiplier

Validation (required to score):

  • gssoc:approved — counts for points
  • gssoc:invalid / gssoc:spam / gssoc:ai-slop — does not score

Type labels (type:*) are auto-detected from files and title. Review and adjust if needed.
Points formula: (difficulty × quality_multiplier) + type_bonus

@indresh404
Copy link
Copy Markdown
Contributor Author

indresh404 commented May 27, 2026

Hi @Priyanshu-byte-coder , along with the CONTRIBUTING/documentation improvements, I also updated pnpm-workspace.yaml in PR #1261 to fix the ERR_PNPM_IGNORED_BUILDS issue occurring with newer pnpm versions.

The update adds the required build dependency allowlist configuration for:

  • core-js
  • esbuild
  • unrs-resolver

This ensures pnpm install works correctly across pnpm v9 and v10+ environments.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Priyanshu-byte-coder Priyanshu-byte-coder Awaiting requested review from Priyanshu-byte-coder Priyanshu-byte-coder is a code owner

Assignees

@indresh404 indresh404

Labels

gssoc26 GSSoC 2026 contribution type:docs GSSoC type bonus: documentation (+5 pts)

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

docs: add CONTRIBUTING.md with setup guide and PR guidelines

1 participant

@indresh404